home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / bbs / tnat301.zip / TNAT301.DOC < prev    next >
Text File  |  1992-03-31  |  12KB  |  331 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                           The News At Ten version 3.01
  8.                     ┌┬────────────────────────────────────┬┐
  9.                     ││ ████████ ███   ██   ████  ████████ ││
  10.                     ││    ██    ████  ██  ██  ██    ██    ││
  11.                     ││    ██    ██ ██ ██ ██▀▀▀▀██   ██    ││
  12.                     ││    ██    ██  ████ ██    ██   ██    ││
  13.                     └┴────────────────────────────────────┴┘
  14.                        Copyright 1989-1992 by Tim Kilgore
  15.                     Protected Under Missouri Copyright Laws
  16.                          1:289/5  (314)443-0319 HST/DS
  17.  
  18.          The News at Ten (TNAT) is possibly the most powerful ANSI-
  19.          ASCII BBS newsletter generator currently available.  A wide
  20.          array of elegant output formats coupled with advanced
  21.          document control and easy configuration make it a favorite of
  22.          users and sysops alike.
  23.  
  24.  
  25.          What it Does -
  26.  
  27.          In a nutshell, TNAT uses near-standard ASCII text files and
  28.          converts them into formated newsletters in both ANSI and
  29.          ASCII flavors with options to insert BBS-specific control
  30.          codes into the resulting file.  It also maintains your input
  31.          files, deleting excessive news bulletins as needed.
  32.  
  33.  
  34.          Setup & TNATCFG
  35.  
  36.          TNATCFG is utility program designed to allow you to quickly
  37.          and easily configure TNAT.  Every menu item has help
  38.          available for it.  Just press F-1 for each menu item and
  39.          context-sensative help window will ride to the rescue.
  40.  
  41.          Before you run TNATCFG, you'll need an overview of how TNAT
  42.          works.  Having a firm understanding of how the program
  43.          functions will make setting it up a lot easier.
  44.  
  45.  
  46.          How it Works
  47.  
  48.          TNAT.EXE is a commandline orientated program.  This means
  49.          that it requires absolutely no user input and it can be
  50.          operated from a batch file as part of a maintainence event.
  51.  
  52.          TNAT reads all of it's setting from a configuration file
  53.          created by TNATCFG or a standard ASCII editor.  The
  54.          configuration file used is determined from the commandline.
  55.          If none is specified, TNAT will attempt to use TNAT.CFG as a
  56.          configuration file.
  57.  
  58.                               TNAT  [personal.cfg]
  59.                                        or
  60.                                 TNAT NEWLET1.CFG
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.          Finding Files to Process -
  74.  
  75.          As part of the configuration process, you tell TNAT which
  76.          subdirectory it will find all text files to use as input.
  77.          You also specify a valid file EXTENSION to process.
  78.  
  79.              INPUT PATH:  C:\TNAT     │   Tells TNAT to process
  80.              EXTENSION :  DOC         │       C:\TNAT\*.DOC
  81.  
  82.          All other files will be ignored.  This allows you to store
  83.          multiple bulletins in single subdirectory PROVIDING that the
  84.          extension used is different.  This also means that
  85.          executables and other data files can safely reside in the
  86.          subdirectory that TNAT uses for input.
  87.  
  88.  
  89.          KILL TNAT, KILL!!!
  90.  
  91.          I hope I have your attention.  As a part of bulletin
  92.          maintenance, TNAT will DELETE excess data files, keeping only
  93.          the most recent files for processing.
  94.  
  95.          The NUMBER OF BULLETINS settings controls the number of
  96.          matching files (see FINDING FILES TO PROCESS, above) that
  97.          TNAT will use as input.  It sorts these files by date and
  98.          time (which it inserts into your newsletter) and will,
  99.          without any chance to abort, KILL any files that exceed the
  100.          total that you have set.
  101.  
  102.          In the past, a user pointed TNAT into his word processing
  103.          subdirectory and accidently deleted hundreds of documents.
  104.                          DON'T LET THIS HAPPEN TO YOU!
  105.  
  106.  
  107.          Input Rules -
  108.  
  109.          TNAT will process ASCII text files that play by TNAT's rules.
  110.          They are -
  111.  
  112.               1.  The first line CANNOT exceed 30 characters.
  113.                   This line contains the TITLE for the news blurb.
  114.  
  115.               2.  ALL other lines cannot exceed 63 characters.
  116.                   Your text will be placed into boxes and the like.
  117.                   TNAT doesn't yet do word wrap, so each line can
  118.                   only be 63 characters or less in length.
  119.  
  120.               3.  Text files in excess of 200 lines are not allowed.
  121.                   This is NEWSLETTER generator, folks.  Online novels
  122.                   are a no-go.
  123.  
  124.          If you break these rules, TNAT will beep and complain about
  125.          it.  It will also tell you where it encountered a problem.
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.          Here is an example of these limitations in action -
  140.  
  141.          WORD-DEFECT 5.1 for DOS ───────────────────────────────────
  142.          0        1         2         3       ||      5         6
  143.          1234567890123456789012345678901234567||45678901234567890123
  144.          ───────────────────────────────────────────────────────────
  145.          Line One is for your TITLE!!!!
  146.          All other lines are limited to 63 characters in length and
  147.          can continue for up to 200 lines. Anything after this point
  148.          will be ignored.
  149.  
  150.          Have a look at 1.TXT, 2.TXT, and 3.TXT if you'd like more
  151.          examples.
  152.  
  153.  
  154.          PAGE STOP -
  155.  
  156.          I'm proud to say that TNAT really blows-away the competition
  157.          when it comes to document control.  Chances are that TNAT can
  158.          provide your BBS with a really sophisticated newsletter with
  159.          a minimal amount of work.
  160.  
  161.          The best control option that you have available is PAGE STOP.
  162.          Most BBSes today examine the text file that they are
  163.          displaying and will stop a display if they encounter the
  164.          appropriate control code.
  165.  
  166.          REMOTE ACCESS uses an ASCII(1) or CONTROL-A to indicate that
  167.          the display must stop.  WildCat! uses @STOP@.  Your BBS
  168.          system may also have a PAGE STOP CODE that will temporarily
  169.          stop a display.
  170.  
  171.          If your BBS system has such a code, use it!  Turn on PAGE
  172.          STOP and enter your PAGE STOP CODE.  It will enhance the
  173.          display greatly.
  174.  
  175.          A PAGE STOP will allow your display to stop immediately after
  176.          each news item.  This means that the newsletter will display
  177.          a news item and then wait for user input.  It adds a natural
  178.          flow to the bulletin and keep the user from 'peeking' ahead
  179.          to the next news item.
  180.  
  181.  
  182.          CLEAR SCREEN -
  183.  
  184.          If PAGE STOP is active, you can activate the CLEAR SCREEN
  185.          option.  If activated, several things will happen.
  186.  
  187.          First, TNAT will attempt to center each news item.  You can
  188.          enhance the effect by trying to keep your news items to 15
  189.          lines or so.
  190.  
  191.          After a PAGE STOP occurs, TNAT display will clear the screen
  192.          and center the next news item.  The news never looked better!
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.          Oh yeah, as an extra, you can also specify a CLEAR SCREEN
  206.          MESSAGE.  You can put whatever you want into it, but I
  207.          recommend that you tell the user how he can about the
  208.          display.  Mine reads -
  209.  
  210.                        Press SPACE to ABORT   (WildCat!)
  211.  
  212.          It might help those users that get 'trapped' in a newsletter
  213.          and don't feel obligated to read it very often as a result.
  214.          Think about it.
  215.  
  216.  
  217.          PAGE BREAK -
  218.  
  219.          A PAGE BREAK is very different from a PAGE STOP.  A PAGE
  220.          BREAK is used on BBS systems that have no other way to stop
  221.          the display of text, even if the text would scroll off the
  222.          user's terminal. (PHOENIX RCS falls into this category.)
  223.  
  224.          The PAGE STOP method is preferred.  If your BBS supports PAGE
  225.          STOP codes, skip this section because you don't need it.
  226.  
  227.          If a PAGE BREAK is needed, TNAT will add the needed code
  228.          every X number of lines.   The NUMBER OF LINES setting allows
  229.          you to control this.  I recommend 23 lines which will allow
  230.          most DOS terminals to read your newsletter with ease.
  231.  
  232.          If you need PAGE BREAK CODES, do NOT activate PAGE STOP.  You
  233.          don't need it.
  234.  
  235.  
  236.          Personalizing TNAT -
  237.  
  238.          TNAT allows you to personalize your newsletter by using
  239.          HEADER files.  The header should be reasonably brief so the
  240.          user doesn't dread your newsletter.  (A friend of mine calls
  241.          newsletters ANSI TORTURE DEVICES because 90% of the BBSes
  242.          that he calls make their newsletters LONG and UNABORTABLE.)
  243.  
  244.          The header is also an excellent way to inject global document
  245.          control codes.  If you need an unabortable display, here is
  246.          your opportunity to add the codes needed to make sure that
  247.          the bulletin cannot be aborted.  If you can define a page
  248.          length, a prompt type, or whatever, this is your ticket.
  249.  
  250.  
  251.          About TNATCFG  -
  252.  
  253.          This document doesn't provide too much specific information
  254.          because most of the specifics are contained in TNATCFG's help
  255.          system.  Just highlight a menu option that you have questions
  256.          about and press F-1.  !!POOF!!  Instant help.
  257.  
  258.          TNATCFG allows you to use a mouse.  Enjoy.
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.          TNATCFG will accept the name of a CFG file as part of the
  272.          commandline.  Thus, the program can be invoked as -
  273.  
  274.                                 TNATCFG  MY.CFG
  275.  
  276.          Unlike TNAT, TNATCFG will NOT default to TNAT.CFG.
  277.  
  278.  
  279.          Disclaimer -
  280.  
  281.          The use or misuse of TNAT.EXE and TNATCFG.EXE are strictly
  282.          YOUR responsibility.  The author, Tim Kilgore, CANNOT be help
  283.          responsible for ANY damages, real or imagined, that the
  284.          aforementioned program cause.  Your use of these program
  285.          indicates your complete agreement with these terms.
  286.  
  287.  
  288.          Registering THE NEWS AT TEN -
  289.  
  290.          The News At Ten is NOT free!  You are granted a 90 day period
  291.          to determine if TNAT suits the needs of you and your BBS.
  292.  
  293.          Remember, your newsletter is the voice of your BBS and it
  294.          will probably be one of the first things that a new user will
  295.          look at.  An abundance of UNREGISTERED or EVALUATION notices
  296.          speaks poorly of your system and makes it difficult to get
  297.          support from callers.
  298.  
  299.          The News At Ten's registration fee is $25.  Registrants will
  300.          receive a key file via their BBS by voice.  See REGISTER.DOC
  301.          for complete details.
  302.  
  303.  
  304.          Release History -
  305.  
  306.          TNAT 1.0 was released in 1989.  It was the author's first
  307.          attempt at a program and it was relatively primitive with one
  308.          whole output format.  It faired poorly, but was a moral
  309.          victory.
  310.  
  311.          TNAT 2.0 followed just a few months later and introduced
  312.          TNATCFG and several new output formats.  This release of the
  313.          program was very successful as the number of BBSes using TNAT
  314.          2.0 will attest.
  315.  
  316.          Work on TNAT 3.0 began in the fall of 1990.  Other
  317.          programming projects, a new job, and other complications
  318.          delayed it's completion.  The main executable was finalized
  319.          in the summer of 1991.  All that remained was TNATCFG and it
  320.          took a vacation to finally complete it.  Having a 9-5 job
  321.          certainly cramps your style.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.